package com.javadaemon.rpgengine.model;

import java.util.Random;

/*
 Copyright (c) 2011, Morten Andersen
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
 * The name of the author may not be used to endorse or promote products
 derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL MORTEN ANDERSEN BE LIABLE FOR ANY
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * This enum encapsulates the cardinal directions, as well as their impact on
 * movement direction.
 * 
 * @author Somnium, JavaDaemon
 * 
 */
public enum DIRECTION
{
	NORTH(0, -1), SOUTH(0, 1), WEST(-1, 0), EAST(1, 0), ;

	private final int dx; // The change on the x-axis
	private final int dy; // The change on the y-axis

	private DIRECTION(int dx, int dy)
	{
		this.dx = dx;
		this.dy = dy;
	}

	public int DX()
	{
		return this.dx;
	}

	public int DY()
	{
		return this.dy;
	}

	public DIRECTION getOpposite()
	{
		switch (this)
		{
		case NORTH:
			return DIRECTION.SOUTH;
		case SOUTH:
			return DIRECTION.NORTH;
		case EAST:
			return DIRECTION.WEST;
		case WEST:
			return DIRECTION.EAST;
		}
		return this;
	}

	public static DIRECTION getRandom()
	{
		Random random = new Random();
		switch (random.nextInt(4))
		{
		case 0:
			return NORTH;
		case 1:
			return EAST;
		case 2:
			return SOUTH;
		case 3:
		default:
			return WEST;
		}
	}
}
